Builder

Used to create a SyncConfiguration. For common use cases, a SyncConfiguration can be created using the SyncConfiguration.create function.

Constructors

Builder

fun Builder(user: User, schema: Set<KClass<out <ERROR CLASS>>>)

Creates a SyncConfiguration.Builder for Flexible Sync.

Builder

fun Builder(user: User, partitionValue: <ERROR CLASS>?, schema: Set<KClass<out <ERROR CLASS>>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync.

Builder

fun Builder(user: User, partitionValue: <ERROR CLASS>?, schema: Set<KClass<out <ERROR CLASS>>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync.

Builder

fun Builder(user: User, partitionValue: Int?, schema: Set<KClass<out <ERROR CLASS>>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync.

Builder

fun Builder(user: User, partitionValue: Long?, schema: Set<KClass<out <ERROR CLASS>>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync.

Builder

fun Builder(user: User, partitionValue: String?, schema: Set<KClass<out <ERROR CLASS>>>)

Creates a SyncConfiguration.Builder for Partition-Based Sync.

build

errorHandler

Sets the error handler used by Synced Realms when reporting errors with their session.

initialSubscriptions

Define the initial io.realm.mongodb.sync.

log

open fun log(level: <ERROR CLASS>, customLoggers: List<<ERROR CLASS>>): SyncConfiguration.Builder

name

Sets the filename of the realm file.

syncClientResetStrategy

Sets the strategy that would handle the client reset by this synced Realm.

waitForInitialRemoteData

fun waitForInitialRemoteData(timeout: <ERROR CLASS> = Duration.INFINITE): SyncConfiguration.Builder

Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened.